Hybris Sales UX API

This API allows the client on Customer Account creation in Salesforce for Phone in a Box Prepaid.

URL

https://[localhost]:[port]/ecom-sales-ux/v1/{businessId}/customer

URL PARAMS

Header

Request

curl --location 'https://nonprod.esb.cloud.lla.com/dev/ecom-sales-ux/ecom-sales-ux/v1/PR/customer' \
--header 'client_id: 12344' \
--header 'client_secret: 11111' \
--header 'Content-Type: application/json' \
--data '{
    "relatedParty": [
        {
            "name": "IVR",
            "role": "Sales channel",
            "@relatedType": "Channel"
        }
    ],
    "name": "John Wick",
    "account": [
        {
            "@referredType": "BillingAccount",
            "@type": "B2C"
        }
    ],
    "characteristic": [
        {
            "name": "consumerPIN",
            "value": "123456"
        },
        {
            "name": "preferredLanguage",
            "value": "EN"
        }
    ],
    "contactMedium": [
        {
            "mediumType": "email",
            "preferred": true,
            "characteristic": {
                "city": "Guaynabo",
                "country": "US",
                "emailAddress": "sergio.mahecha@cwc.com",
                "phoneNumber": "1111111111",
                "postCode": "00969",
                "stateOrProvince": "PR",
                "street1": "35 Avenida Juan Carlos de Borbon"
            }
        }
    ],
    "@baseType": "Customer"
}'

Definitions

Each of the request parameters is detailed.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 200 ]

OK - update request processed successfully, response body contains an entity corresponding to the requested resource.

{
    "id": "0039947",
    "relatedParty": [
        {
            "id": "0014C00000pP3EhQAK",
            "@type": "SalesforceInternalIdRef"
        },
        {
            "name": "IVR",
            "role": "Sales channel",
            "@relatedType": "Channel"
        }
    ],
    "name": "John Wick",
    "account": [
        {
            "@referredType": "BillingAccount",
            "@type": "B2C"
        }
    ],
    "characteristic": [
        {
            "name": "consumerPIN",
            "value": "123456"
        },
        {
            "name": "preferredLanguage",
            "value": "EN"
        }
    ],
    "contactMedium": [
        {
            "mediumType": "email",
            "preferred": true,
            "characteristic": {
                "city": "Guaynabo",
                "country": "US",
                "emailAddress": "sergio.mahecha@cwc.com",
                "phoneNumber": "1111111111",
                "postCode": "00969",
                "stateOrProvince": "PR",
                "street1": "35 Avenida Juan Carlos de Borbon"
            }
        }
    ],
    "@baseType": "Customer"
}

Definitions

Each of the response parameters is detailed for POST /customer response body

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications.

{
  "errors" : [{
      "code" : 400,
      "message" : "Invalid_Request.",
      "description" : "The request is invalid"
    }]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.

{
  "errors" : [{
      "code" : 401,
      "message" : "The user could not be authenticated for this request.",
      "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource"
    }]
}

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.

{
  "errors" : [{
      "code" : 404,
      "message" : "The request is invalid or not properly formed.",
      "description" : "The requested operation failed because a resource associated with the request could not be found."
    }]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.

{
    "errors": [{
            "code": 405,
             "message": "APIKIT:METHOD_NOT_ALLOWED",
             "description": "HTTP Method GET not allowed for : /{businessId}/customer"
        }]
}

[ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.

{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": "error description"
    }]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation POST /customer for Business Id: xxxx not implemented"
    }]
  }

[ 502]

Bad Gateway - gateway is available but backend service is not. The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

[ 503 ]

Service Unavailable - temporary maintenance of service, try again later. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay will be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. Note: The existence of the 503 status code does not imply that a server will use it when becoming overloaded. Servers may simply refuse the connection.

    Retry-After: 120